Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

misc: improve bug report issue template #4878

Merged
merged 6 commits into from
Jun 2, 2021
Merged

misc: improve bug report issue template #4878

merged 6 commits into from
Jun 2, 2021

Conversation

lex111
Copy link
Contributor

@lex111 lex111 commented May 31, 2021

Motivation

Come from #4853 (comment)

Should help reduce unwanted bug reports. Or do we still need to mention about this in docs too?

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

N/A

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

@lex111 lex111 added the pr: maintenance This PR does not produce any behavior differences to end users when upgrading. label May 31, 2021
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label May 31, 2021
@netlify
Copy link

netlify bot commented May 31, 2021 •
edited
Loading

✔️ [V1]

🔨 Explore the source changes: da697af

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-1/deploys/60b735684bfa1f000747e576

😎 Browse the preview: https://deploy-preview-4878--docusaurus-1.netlify.app

@netlify
Copy link

netlify bot commented May 31, 2021 •
edited
Loading

✔️ [V2]

🔨 Explore the source changes: da697af

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/60b73568b472610007ece863

😎 Browse the preview: https://deploy-preview-4878--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented May 31, 2021 •
edited
Loading

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 37
🟢 Accessibility 97
🟢 Best practices 100
🟢 SEO 100
🟠 PWA 64

Lighthouse ran on https://deploy-preview-4878--docusaurus-2.netlify.app/

@github-actions
Copy link

github-actions bot commented May 31, 2021 •
edited
Loading

Size Change: 0 B

Total Size: 620 kB

ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 88.1 kB 0 B
website/build/assets/js/main.********.js 443 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html 62.1 kB 0 B
website/build/docs/introduction/index.html 235 B 0 B
website/build/index.html 26.9 kB 0 B

compressed-size-action

HonkingGoose
HonkingGoose reviewed Jun 1, 2021
View reviewed changes
Copy link
Contributor

@HonkingGoose HonkingGoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do you feel about this wording?

I think it's clearer on what the user needs to do, and is still understandable if they skip over the comment. 😄

.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
@lex111 @HonkingGoose
Apply suggestions from code review
95d01ec 
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@lex111
Copy link
Contributor Author

lex111 commented Jun 1, 2021

@HonkingGoose great suggestions, thanks!

@lex111 @HonkingGoose
Update .github/ISSUE_TEMPLATE/bug.md
2e3bfdc 
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
slorber
slorber approved these changes Jun 1, 2021
View reviewed changes
Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, that looks like a good idea

.github/ISSUE_TEMPLATE/bug.md Outdated Show resolved Hide resolved
@slorber
Copy link
Collaborator

slorber commented Jun 1, 2021

I have also noticed a trick used by some other repos for questions:

https://github.com/software-mansion/react-native-reanimated/blob/master/.github/ISSUE_TEMPLATE/config.yml

image

Maybe we should do the same so that questions end up in the discussions instead of issues?

lex111 and others added 2 commits June 2, 2021 10:37
@lex111 @slorber
Update .github/ISSUE_TEMPLATE/bug.md
6a3ecda 
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
@lex111
Update bug.md
da697af
@lex111
Copy link
Contributor Author

lex111 commented Jun 2, 2021

I agree, we can do it in new PR then.

@HonkingGoose
Copy link
Contributor

@lex111 and @slorber, here is the documentation from GitHub for the config.yml file that you can use to configure the issue template chooser:

@slorber slorber merged commit 1afb0dc into master Jun 2, 2021
@slorber slorber mentioned this pull request Jun 2, 2021
Merged
@slorber slorber deleted the lex111-patch-1 branch August 17, 2021 18:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HonkingGoose HonkingGoose HonkingGoose left review comments

@slorber slorber slorber approved these changes

Assignees
No one assigned
Labels
CLA Signed Signed Facebook CLA pr: maintenance This PR does not produce any behavior differences to end users when upgrading.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@lex111 @slorber @HonkingGoose @facebook-github-bot